/**
 * Copyright © 2008, EMC Corporation.
 * Redistribution and use in source and binary forms, with or without modification, 
 * are permitted provided that the following conditions are met:
 *
 *     + Redistributions of source code must retain the above copyright notice, 
 *       this list of conditions and the following disclaimer.
 *     + Redistributions in binary form must reproduce the above copyright 
 *       notice, this list of conditions and the following disclaimer in the 
 *       documentation and/or other materials provided with the distribution.
 *     + The name of EMC Corporation may not be used to endorse or promote 
 *       products derived from this software without specific prior written 
 *       permission.
 *
 *      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *      "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 
 *      TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 *      PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 
 *      BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 *      CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 *      SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 *      INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *      CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 *      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *      POSSIBILITY OF SUCH DAMAGE.
 */
package com.emc.esu.api
{

	/**
	 * Allows you to specify extended options when listing directories or listing
	 * objects.  When using paged directory responses (limit > 0), the token
	 * used for subsequent responses will be returned through this object.
	 * @since 1.4.1
	 */
	public class ListOptions
	{
		private var _includeMetadata:Boolean;
		private var _limit:int;
		private var _token:String;
		private var _userMetadata:Array;
		private var _systemMetadata:Array;
		
		public function ListOptions()
		{
			includeMetadata = false;
			limit = 0;
		}
		
		public function get includeMetadata():Boolean {
			return _includeMetadata;
		}
		public function set includeMetadata( value:Boolean ):void {
			_includeMetadata = value;
		}
		
		public function get limit():int {
			return _limit;
		}
		public function set limit( value:int ):void {
			_limit = value;
		}
		
		public function get token():String {
			return _token;
		}
		public function set token( value:String ):void {
			_token = value;
		}
		
		public function get userMetadata():Array {
			return _userMetadata;
		}
		public function set userMetadata( value:Array ):void {
			_userMetadata = value;
		}
		
		public function get systemMetadata():Array {
			return _systemMetadata;
		}
		public function set systemMetadata( value:Array ):void {
			_systemMetadata = value;
		}
		
	}
}